home *** CD-ROM | disk | FTP | other *** search
/ Business Assistant / Business Assistant.iso / formlet / formgen / list.doc < prev    next >
Text File  |  1987-05-07  |  41KB  |  1,021 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                          LIST Version 6.2a
  10.                 (c) Copyright  Vernon D. Buerg 1987
  11.                         All rights reserved
  12.  
  13.                              May 7, 1987
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                          Table of Contents
  23.                          -----------------
  24.  
  25.                 Description of use ...............  1
  26.  
  27.                 Keys and commands ................  3
  28.                   Function keys ..................  4
  29.                   Alt- keys ......................  5
  30.  
  31.                 Positioning to lines .............  6
  32.  
  33.                 Displaying multiple files ........  6
  34.  
  35.                 Extracting/marking lines .........  7
  36.  
  37.                 Display format ...................  8
  38.                   Status line ....................  8
  39.                   Command line ...................  9
  40.  
  41.                 Screen colors .................... 10
  42.  
  43.                 Cloning procedure ................ 11
  44.                   DEBUG information .............. 12
  45.  
  46.                 Searching for text................ 13
  47.  
  48.                 Filtering ........................ 14
  49.  
  50.                 Exotic functions ................. 15
  51.                   File sharing ................... 15
  52.                   Invoking DOS commands .......... 15
  53.                   Screen saving .................. 15
  54.  
  55.                 Restrictions ..................... 16
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                                         LIST     Page 1
  62.                           Description of Use
  63.                           ------------------
  64.  
  65.    Command  LIST
  66.    -------------
  67.  
  68.  
  69.    Purpose:
  70.            You use LIST to display  files on your monitor, line  by line
  71.         with the aid of scrolling, positioning and filtering commands.
  72.  
  73.  
  74.    Format:
  75.                  LIST  [d:][path]filename[.ext]
  76.  
  77.  
  78.    Remarks:
  79.            You may rename the program file to any convenient name,  such
  80.         as  L.COM,  READ.COM,  or LIST.COM.
  81.  
  82.            Using LIST is fairly straight forward.  You type the  command
  83.         LIST at the DOS  prompt, followed by the  name of the file  that
  84.         you want to see.  For example: LIST CONFIG.SYS would display the
  85.         file CONFIG.SYS.
  86.  
  87.            Once the file  is displayed on  your screen, you  may use the
  88.         cursor positioning keys to  move around and see  different parts
  89.         of the file.  For example,  when LIST first starts, you  see the
  90.         first 23 lines of the file.  To see the next 23 lines, or  page,
  91.         press the PgDn key.   The PgUp key moves  you back one page  and
  92.         shows you the  previous 23 lines.   The up-arrow and  down-arrow
  93.         keys move it  one line at a time.  When you are finished,  press
  94.         the ESCape key and you are returned to the DOS prompt.
  95.  
  96.            The "filename" is optional.  If omitted, you are prompted  to
  97.         enter  a filename.   You  may  include  drive,  path,  and  wild
  98.         cards in the file name.   The first file which matches that name
  99.         is displayed.  After  the file is displayed, the next file which
  100.         matches the "filename" may be displayed, too.
  101.  
  102.            You may also use LIST  to display piped or redirected  files.
  103.         If you are unfamiliar with these, you may skip to the next page.
  104.  
  105.         To display a redirected file, use a < (less than symbol)  before
  106.         the name  of the  file  and  add the  /S parameter  to the  LIST
  107.         command.  For example:
  108.  
  109.                 dir a: >xyz
  110.                 list <xyz /s
  111.  
  112.         To display a piped file,  omit the filename,  but supply the /S.
  113.                 dir a: | list /s
  114.  
  115.         Or, to LIST a file within an ARC archive:
  116.                 arc /p arcname.arc filename.ext | list /s
  117.                                 - or -
  118.                 arce arcname filename.ext /p | list /S
  119.  
  120.  
  121. LIST     Page 2
  122.  
  123.                          Description of Use (cont'd)
  124.                          ------------------
  125.  
  126.            Because  files  contain  different  kinds  of data, there are
  127.         several commands  to tell  LIST how  to display  the data.   The
  128.         process that LIST uses to make the file data readable is  called
  129.         filtering.  The filters in LIST can:
  130.  
  131.             o  replace non-text and control characters with blanks
  132.             o  expand TAB characters
  133.             o  display line drawing characters
  134.             o  change 8-bit (W*) data to readable 7-bit text
  135.             o  display the hexidecimal values for each character
  136.             o  remove "junk", such as control codes and backspaces
  137.  
  138.            LIST was  designed to  display ASCII  files.  That  is, files
  139.         which  contain  text, and  not  binary  or  control codes.  Text
  140.         characters usually  range from  a value  of 32  to 127.  To view
  141.         binary  files  (COM,  EXE,  etc),  the  alt-H (hex dump display)
  142.         command is available.
  143.  
  144.  
  145.            Characters  below  32  (a  blank)  are  replaced with a funny
  146.         character to indicate that a non-displayable character has  been
  147.         encountered.  This  character is  an upside-down  question mark.
  148.         Characters above 127 may be valid graphic characters, and may be
  149.         displayed  if  the  '8'  command  is  in effect.  To insure that
  150.         characters above ASCII value 127 are not displayed, use the  '7'
  151.         command.
  152.  
  153.  
  154.            The top  line of  the display  gives the  file name,  current
  155.         right  scroll  offset,  and  the  FILE's creation date and time.
  156.         Optionally, a ruler  may be displayed  on the top  line by using
  157.         the alt-R keys.
  158.  
  159.            The  file  is  displayed  with  one  logical  record  on each
  160.         80-column display line.   A logical record  ends in a  linefeed.
  161.         The maximum logical record may  be 256 characters long.  If  the
  162.         record exceeds 80  characters, you may  view the portion  beyond
  163.         the 80 columns  by using the  scroll right command,  or by using
  164.         the  Wrap  feature.   The  Wrap  command  toggles  ON or OFF the
  165.         wrapping  of  lines  longer  than  80 characters.  With Wrap on,
  166.         lines are displayed in their entirety, 80 characters per display
  167.         line.  The scroll -left  and -right functions are  disabled when
  168.         Wrap is ON.
  169.  
  170.            The file may  be PRINTed as  it it displayed.   The P command
  171.         toggles  the  printer  on  or  off.   When  first entered, the P
  172.         command causes the current screen  to be printed.  As new  lines
  173.         are displayed, they too are printed.  Printing may be stopped by
  174.         entering another P command.  The PrtSc key may also be used, but
  175.         the title and prompt lines will be printed with the lines of the
  176.         file.  Empty lines  cause a line  to be skipped  on the printer.
  177. |       The letter P  is displayed on the bottom command     line  while
  178. |       printing. See the section on extracting lines for other methods.
  179.  
  180.  
  181.                                                         LIST     Page 3
  182.  
  183.                         Commands and Keys
  184.                         -----------------
  185.  
  186.         Control key   Function
  187.         -----------   -----------------------------------------------
  188. |       left arrow    scroll left 10 columns
  189. |       right arrow   scroll right 10 columns
  190.         up arrow      up one (previous) line
  191.         down arrow    down one (next) line
  192.  
  193.         Enter         continue to next page
  194.         END           position to end of file (bottom)
  195. |       ESCape        Exit program unconditionally
  196.         HOME          restart from first line (top)
  197.         PgUp          scroll up one page, 23 lines
  198.         PgDn          scroll down one page, 23 lines
  199.  
  200.  
  201.         Letter(s)     Default   Function
  202.         ---------     -------   ----------------------------------------
  203.         A                       find next occurance of 'text' (Again)
  204.         B                       skip to end of file (Bottom)
  205.         C               off     toggles Closing of files, also alt-S
  206.         D                       scroll Down one